Replace 'workspace' and 'my-app' with 'instance' in CLI help strings#240
Merged
Merged
Conversation
…and user messages - Updated command short descriptions to use 'instance' instead of 'workspace' - Updated command long descriptions and examples to use 'instance' terminology - Replaced 'my-app' examples with 'instance' in shell and open commands - Updated user-facing status messages, error messages, and spinner text - Maintained consistent 'instance' terminology across all CLI help output Files modified: - pkg/cmd/delete/delete.go: Updated error message - pkg/cmd/open/open.go: Updated command description, examples, and status messages - pkg/cmd/recreate/recreate.go: Updated spinner status messages - pkg/cmd/reset/reset.go: Updated spinner status messages - pkg/cmd/shell/shell.go: Updated command description, examples, and error message - pkg/cmd/stop/stop.go: Updated command description, flag description, and error message Co-Authored-By: Alec Fong <alecsanf@usc.edu>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Replace 'workspace' and 'my-app' with 'instance' in CLI help strings
Summary
This PR updates user-facing CLI help text, examples, and messages to use consistent "instance" terminology instead of "workspace" and "my-app". The changes are purely cosmetic string replacements that improve terminology consistency across the CLI without affecting any functionality.
Files modified:
pkg/cmd/delete/delete.go: Updated error messagepkg/cmd/open/open.go: Updated command description, examples, and status messagespkg/cmd/recreate/recreate.go: Updated spinner status messagespkg/cmd/reset/reset.go: Updated spinner status messagespkg/cmd/shell/shell.go: Updated command description, examples, and error messagepkg/cmd/stop/stop.go: Updated command description, flag description, and error messageTypes of changes:
Review & Testing Checklist for Human
brev help,brev shell --help,brev open --help, etc. to verify help text displays correctly with "instance" terminologyDiagram
%%{ init : { "theme" : "default" }}%% graph TD CLI["CLI Root<br/>pkg/cmd/cmd.go"]:::context Shell["Shell Command<br/>pkg/cmd/shell/shell.go"]:::major-edit Open["Open Command<br/>pkg/cmd/open/open.go"]:::major-edit Stop["Stop Command<br/>pkg/cmd/stop/stop.go"]:::major-edit Delete["Delete Command<br/>pkg/cmd/delete/delete.go"]:::minor-edit Reset["Reset Command<br/>pkg/cmd/reset/reset.go"]:::minor-edit Recreate["Recreate Command<br/>pkg/cmd/recreate/recreate.go"]:::minor-edit CLI --> Shell CLI --> Open CLI --> Stop CLI --> Delete CLI --> Reset CLI --> Recreate Shell -.->|"Help text & examples"| HelpOutput["CLI Help Output"]:::context Open -.->|"Help text & examples"| HelpOutput Stop -.->|"Help text & flags"| HelpOutput subgraph Legend L1["Major Edit<br/>(descriptions + examples)"]:::major-edit L2["Minor Edit<br/>(status messages)"]:::minor-edit L3["Context/No Edit"]:::context end classDef major-edit fill:#90EE90 classDef minor-edit fill:#ADD8E6 classDef context fill:#FFFFFFNotes
Link to Devin run: https://app.devin.ai/sessions/589d444b5b7845078af384a16b3c99b9
Requested by: @theFong